/* Copyright (C) 2008  Romolo Camplani, Marco Fortunato, Marco Marelli, Guido Rota, Fabio A. Schreiber et al.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.dei.perla.parser.grammar.errors;

public abstract class AbstractError implements IError, Comparable<AbstractError>{

	/**
	 * Descrizione generale dell'errore
	 */
	private String errorDescription;
	
	/**
	 * Dettagli dell' errore
	 */
	private String errorDetails;
	
	/**
	 * Priorita' dell'errore
	 */
	private ErrorPriority errorPriority;
	
	/**
	 * Costruttore
	 * @param errorDescription descrizione generale dell'errore
	 * @param errorDetails dettagli dell'errore
	 * @param errorPriority priorita' dell'errore
	 */
	public AbstractError(String errorDescription, String errorDetails, ErrorPriority errorPriority) {
		
		this.errorDescription = errorDescription;
		this.errorDetails = errorDetails;
		this.errorPriority = errorPriority;
	}
	
	/**
	 * Restituisce la priorita' associata all'errore
	 * 
	 * @return ErrorPriority associato all'errore
	 */
	protected final ErrorPriority getErrorPriority() {
		
		return errorPriority;
	}
	
	/**
	 * Restituisce la descrizione generale dell'errore
	 * 
	 * @return descrizione generale dell'errore
	 */
	protected final String getErrorDescription() {
		
		return errorDescription;
	}
	
	/**
	 * Restituisce i dettagli dell'errore
	 * 
	 * @return dettagli dell'errore
	 */
	protected final String getErrorDetails() {
		
		return errorDetails;
	}
	
	/**
	 * Metodo per la restituzione di una stringa che caratterizza completamente l'errore
	 * @return stringa di riepilogo dell'errore
	 */
	protected abstract String getCompleteErrorDetails();
	
	/**
	 * Metodo di confronto usato per ordinare gli errori in base alla loro priorita' 
	 */
	public final int compareTo(AbstractError otherError) {
		
		return errorPriority.compareTo(otherError.getErrorPriority());
	}
}
